plugin: Add some comments on its purpose

https://gitlab.gnome.org/GNOME/gnome-shell/merge_requests/315

diff --git a/src/gnome-shell-plugin.c b/src/gnome-shell-plugin.c
index fa8410d40aa66559449e04420fcfba11558267e4..5ed8e553e5490786290d89393933e154b2f2c538 100644 (file)
--- a/src/gnome-shell-plugin.c
+++ b/src/gnome-shell-plugin.c
@@ -21,6 +21,16 @@
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+/*
+ * GnomeShellPlugin is the entry point for for GNOME Shell into and out of
+ * Mutter. By registering itself into Mutter using
+ * meta_plugin_manager_set_plugin_type(), Mutter will call the vfuncs of the
+ * plugin at the appropriate time.
+ *
+ * The funcions in in GnomeShellPlugin are all just stubs, which just call the
+ * similar methods in GnomeShellWm.
+ */
+
 #include "config.h"
 
 #include <stdlib.h>